Customize the Homepage and other Partials
Provides a url relative to the root of the grunt-docular plugin which points to an html "partial" file. This is a file that contains valid html that does not contain the html, head, or body elements.
The homepage partial has access to the following directives:
The configuration for grunt-docular.com
module.exports = function(grunt) { // Project configuration. grunt.initConfig({ pkg: grunt.file.readJSON('package.json'), docular: { // other options ommitted for simplicity docular_partial_home: 'home.html' } }); // Load the plugin that provides the "docular" tasks. grunt.loadNpmTasks('grunt-docular'); // Default task(s). grunt.registerTask('default', ['docular']); };
This site grunt-docular.com uses the following for it's homepage:
Documentation... and Beyond!
Docular is a NodeJS package that is based on AngularJS's documentation generation implementation. Docular is best used through the Grunt plugin "grunt-docular".
Docular is currently in BetaWahooo! Docular is almost out of Beta!
Documentation is almost complete, and a final list of features for the first release have been identified. Stay tuned!
Suggest a Feature / Report a BugGet Started
Documentation Samples
This entire site was generated through Docular, so anything you see here can be recreated using Docular.
Browse around the site and be sure to check out the AngularJS source documention and Docular source to see how you can customize your own documentation experience.
Docular Uses: